RtResetEvent

RtResetEvent sets the state of the specified event object to non-signaled.

Syntax

BOOL RtResetEvent(
    HANDLE hEvent
);

Parameters

hEvent

Identifies the event object. The RtCreateEvent or RtOpenEvent function returns this handle.

Return Values

TRUE if the function succeeds, FALSE if the function fails.

To get extended error information, call GetLastError.

Remarks

The state of an event object remains non-signaled until it is explicitly set to signaled by the RtSetEvent or RtPulseEvent function. The non-signaled state blocks the execution of any threads that have specified the event object in a call to a wait function.

The RtResetEvent function is used primarily for manual-reset event objects, which must be set explicitly to the non-signaled state. Auto-reset event objects automatically change from signaled to non-signaled after a single waiting thread is released.

Requirements

Header	Rtapi.h
Library	rtapi_w32.lib (Windows), Rtx_Rtss.lib (RTSS)